Repository navigation
docs: add the implementation-record template - #3
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
docs/implementations/_TEMPLATE.md, the template every implementation record is meant to follow, and a record of this change.The template has the seven required sections in order (Problem / Motivation, What Changed, Implementation Approach, Mathematical / Statistical Details, Design Decisions, Verification, Related Docs). Each has an HTML comment saying what belongs in it; comments do not render on GitHub.
The same file goes into
ddr4-udimm,spdrand.github, one pull request each. Existing records are not changed.Check:
git hash-object docs/implementations/_TEMPLATE.mdgives6df8c0e6b212496b2b38658fb43e6bba1dcf11b6in all three repositories.